<?php
/**
 * TOP API: taobao.logistics.online.send request
 * 
 * @author auto create
 * @since 1.0, 2012-04-17 12:36:56
 */
class LogisticsOnlineSendRequest
{
    /** 
     * 卖家联系人地址库ID，可以通过taobao.logistics.address.search接口查询到地址库ID。<br><font color='red'>如果为空，取的卖家的默认退货地址</font><br>
     **/
    private $cancelId;
    
    /** 
     * 物流公司代码.如"POST"就代表中国邮政,"ZJS"就代表宅急送.调用 taobao.logistics.companies.get 获取。
<br><font color='red'>如果是货到付款订单，选择的物流公司必须支持货到付款发货方式</font>
     **/
    private $companyCode;
    
    /** 
     * feature参数格式<br>
范例: mobileCode=tid1:手机串号1,手机串号2|tid2:手机串号3;machineCode=tid3:3C机器号A,3C机器号B<br>
mobileCode无忧购的KEY,machineCode为3C的KEY,多个key之间用”;”分隔<br>
“tid1:手机串号1,手机串号2|tid2:手机串号3”为mobileCode对应的value。
"|"不同商品间的分隔符。<br>
例A商品和B商品都属于无忧购商品，之间就用"|"分开。<br>
TID就是商品代表的子订单号，对应taobao.trade.fullinfo.get 接口获得的oid字段。(通过OID可以唯一定位到当前商品上)<br>
":"TID和具体传入参数间的分隔符。冒号前表示TID,之后代表该商品的参数属性。<br>
"," 属性间分隔符。（对应商品数量，当存在一个商品的数量超过1个时，用逗号分开）。<br>
具体:当订单中A商品的数量为2个，其中手机串号分别为"12345","67890"。<br>
参数格式：mobileCode=TIDA:12345,67890。
TIDA对应了A宝贝，冒号后用逗号分隔的"12345","67890".说明本订单A宝贝的数量为2，值分别为"12345","67890"。<br>
当存在"|"时，就说明订单中存在多个无忧购的商品，商品间用"|"分隔了开来。|"之后的内容含义同上。
     **/
    private $feature;
    
    /** 
     * 运单号.具体一个物流公司的真实运单号码。淘宝官方物流会校验，请谨慎传入；
     **/
    private $outSid;
    
    /** 
     * 卖家联系人地址库ID，可以通过taobao.logistics.address.search接口查询到地址库ID。<font color='red'>如果为空，取的卖家的默认取货地址</font>
     **/
    private $senderId;
    
    /** 
     * 淘宝交易ID
     **/
    private $tid;
    
    private $apiParas = array();
    
    public function setCancelId($cancelId)
    {
        $this->cancelId = $cancelId;
        $this->apiParas["cancel_id"] = $cancelId;
    }

    public function getCancelId()
    {
        return $this->cancelId;
    }

    public function setCompanyCode($companyCode)
    {
        $this->companyCode = $companyCode;
        $this->apiParas["company_code"] = $companyCode;
    }

    public function getCompanyCode()
    {
        return $this->companyCode;
    }

    public function setFeature($feature)
    {
        $this->feature = $feature;
        $this->apiParas["feature"] = $feature;
    }

    public function getFeature()
    {
        return $this->feature;
    }

    public function setOutSid($outSid)
    {
        $this->outSid = $outSid;
        $this->apiParas["out_sid"] = $outSid;
    }

    public function getOutSid()
    {
        return $this->outSid;
    }

    public function setSenderId($senderId)
    {
        $this->senderId = $senderId;
        $this->apiParas["sender_id"] = $senderId;
    }

    public function getSenderId()
    {
        return $this->senderId;
    }

    public function setTid($tid)
    {
        $this->tid = $tid;
        $this->apiParas["tid"] = $tid;
    }

    public function getTid()
    {
        return $this->tid;
    }

    public function getApiMethodName()
    {
        return "taobao.logistics.online.send";
    }
    
    public function getApiParas()
    {
        return $this->apiParas;
    }
    
    public function check()
    {
        
        RequestCheckUtil::checkNotNull($this->companyCode,"companyCode");
        RequestCheckUtil::checkNotNull($this->tid,"tid");
    }
}
